@types/object-hash

What is @types/object-hash?

@types/object-hash provides TypeScript type definitions for the object-hash library, which is used to create unique hashes for JavaScript objects. This is useful for tasks such as caching, object comparison, and ensuring data integrity.

What are @types/object-hash's main functionalities?

Basic Hashing

This feature allows you to generate a hash for a simple JavaScript object. The hash can be used to uniquely identify the object.

const objectHash = require('object-hash');
const hash = objectHash({ foo: 'bar' });
console.log(hash);

Hashing with Options

This feature allows you to customize the hashing algorithm and encoding. In this example, the SHA-1 algorithm and hex encoding are used.

const objectHash = require('object-hash');
const hash = objectHash({ foo: 'bar' }, { algorithm: 'sha1', encoding: 'hex' });
console.log(hash);

Hashing Arrays

This feature allows you to generate a hash for an array. The hash will uniquely represent the array's contents.

const objectHash = require('object-hash');
const hash = objectHash([1, 2, 3, 4]);
console.log(hash);

Hashing Nested Objects

This feature allows you to generate a hash for nested objects. The hash will uniquely represent the entire structure of the nested object.

const objectHash = require('object-hash');
const hash = objectHash({ foo: { bar: 'baz' } });
console.log(hash);

Other packages similar to @types/object-hash

hash-it

hash-it is a lightweight library for creating unique hashes for JavaScript objects. It is similar to object-hash but focuses on performance and simplicity.

crypto

The crypto module in Node.js provides cryptographic functionality that includes a set of wrappers for OpenSSL's hash, HMAC, cipher, decipher, sign, and verify functions. While it is more general-purpose, it can be used to hash objects with some additional work.

fast-json-stable-stringify

fast-json-stable-stringify is a library that provides deterministic JSON.stringify() results. It can be used in conjunction with a hashing function to create consistent hashes for objects.

README

Installation

npm install --save @types/object-hash

Summary

This package contains type definitions for object-hash (https://github.com/puleos/object-hash).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/object-hash.

Additional Details

• Last updated: Tue, 07 Nov 2023 09:09:39 GMT
• Dependencies: none

Credits

These definitions were written by Michael Zabka, Artur Diniz, and Martin Badin.